FloatArray

class FloatArray(size: Int)

An array of floats. When targeting the JVM, instances of this class are represented as float[].

Constructors

FloatArray
Link copied to clipboard
fun FloatArray(size: Int, init: (Int) -> Float)

Creates a new array of the specified size, where each element is calculated by calling the specified init function.

FloatArray
Link copied to clipboard
fun FloatArray(size: Int)

Creates a new array of the specified size, with all elements initialized to zero.

Functions

get
Link copied to clipboard
operator fun get(index: Int): Float

Returns the array element at the given index. This method can be called using the index operator.

iterator
Link copied to clipboard
operator fun iterator(): FloatIterator

Creates an iterator over the elements of the array.

set
Link copied to clipboard
operator fun set(index: Int, value: Float)

Sets the element at the given index to the given value. This method can be called using the index operator.

Properties

size
Link copied to clipboard
val size: Int

Returns the number of elements in the array.

Extensions

all
Link copied to clipboard
inline fun FloatArray.all(predicate: (Float) -> Boolean): Boolean

Returns true if all elements match the given predicate.

any
Link copied to clipboard
fun FloatArray.any(): Boolean

Returns true if array has at least one element.

inline fun FloatArray.any(predicate: (Float) -> Boolean): Boolean

Returns true if at least one element matches the given predicate.

asIterable
Link copied to clipboard
fun FloatArray.asIterable(): Iterable<Float>

Creates an Iterable instance that wraps the original array returning its elements when being iterated.

asList
Link copied to clipboard
expect fun FloatArray.asList(): List<Float>

Returns a List that wraps the original array.

actual fun FloatArray.asList(): List<Float>

Returns a List that wraps the original array.

actual inline fun FloatArray.asList(): List<Float>

Returns a List that wraps the original array.

actual fun FloatArray.asList(): List<Float>

Returns a List that wraps the original array.

asSequence
Link copied to clipboard
fun FloatArray.asSequence(): Sequence<Float>

Creates a Sequence instance that wraps the original array returning its elements when being iterated.

associate
Link copied to clipboard
inline fun <K, V> FloatArray.associate(transform: (Float) -> Pair<K, V>): Map<K, V>

Returns a Map containing key-value pairs provided by transform function applied to elements of the given array.

associateBy
Link copied to clipboard
inline fun <K> FloatArray.associateBy(keySelector: (Float) -> K): Map<K, Float>

Returns a Map containing the elements from the given array indexed by the key returned from keySelector function applied to each element.

inline fun <K, V> FloatArray.associateBy(keySelector: (Float) -> K, valueTransform: (Float) -> V): Map<K, V>

Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to elements of the given array.

associateByTo
Link copied to clipboard
inline fun <K, M : MutableMap<in K, in Float>> FloatArray.associateByTo(destination: M, keySelector: (Float) -> K): M

Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function applied to each element of the given array and value is the element itself.

inline fun <K, V, M : MutableMap<in K, in V>> FloatArray.associateByTo(destination: M, keySelector: (Float) -> K, valueTransform: (Float) -> V): M

Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function and and value is provided by the valueTransform function applied to elements of the given array.

associateTo
Link copied to clipboard
inline fun <K, V, M : MutableMap<in K, in V>> FloatArray.associateTo(destination: M, transform: (Float) -> Pair<K, V>): M

Populates and returns the destination mutable map with key-value pairs provided by transform function applied to each element of the given array.

associateWith
Link copied to clipboard
inline fun <V> FloatArray.associateWith(valueSelector: (Float) -> V): Map<Float, V>

Returns a Map where keys are elements from the given array and values are produced by the valueSelector function applied to each element.

associateWithTo
Link copied to clipboard
inline fun <V, M : MutableMap<in Float, in V>> FloatArray.associateWithTo(destination: M, valueSelector: (Float) -> V): M

Populates and returns the destination mutable map with key-value pairs for each element of the given array, where key is the element itself and value is provided by the valueSelector function applied to that key.

average
Link copied to clipboard
fun FloatArray.average(): Double

Returns an average value of elements in the array.

binarySearch
Link copied to clipboard
fun FloatArray.binarySearch(element: Float, fromIndex: Int = 0, toIndex: Int = size): Int

Searches the array or the range of the array for the provided element using the binary search algorithm. The array is expected to be sorted, otherwise the result is undefined.

component1
Link copied to clipboard
inline operator fun FloatArray.component1(): Float

Returns 1st element from the array.

component2
Link copied to clipboard
inline operator fun FloatArray.component2(): Float

Returns 2nd element from the array.

component3
Link copied to clipboard
inline operator fun FloatArray.component3(): Float

Returns 3rd element from the array.

component4
Link copied to clipboard
inline operator fun FloatArray.component4(): Float

Returns 4th element from the array.

component5
Link copied to clipboard
inline operator fun FloatArray.component5(): Float

Returns 5th element from the array.

contains
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.4")
operator fun FloatArray.contains(element: Float): Boolean

Returns true if element is found in the array.

contentEquals
Link copied to clipboard
@DeprecatedSinceKotlin(hiddenSince = "1.4")
expect infix fun FloatArray.contentEquals(other: FloatArray): Boolean
expect infix fun FloatArray?.contentEquals(other: FloatArray?): Boolean

Returns true if the two specified arrays are structurally equal to one another, i.e. contain the same number of the same elements in the same order.

@DeprecatedSinceKotlin(hiddenSince = "1.4")
actual infix inline fun FloatArray.contentEquals(other: FloatArray): Boolean
@JvmName(name = "contentEqualsNullable")
actual infix inline fun FloatArray?.contentEquals(other: FloatArray?): Boolean

Returns true if the two specified arrays are structurally equal to one another, i.e. contain the same number of the same elements in the same order.

@DeprecatedSinceKotlin(hiddenSince = "1.4")
actual infix fun FloatArray.contentEquals(other: FloatArray): Boolean
actual infix fun FloatArray?.contentEquals(other: FloatArray?): Boolean

Returns true if the two specified arrays are structurally equal to one another, i.e. contain the same number of the same elements in the same order.

@DeprecatedSinceKotlin(hiddenSince = "1.4")
actual infix fun FloatArray.contentEquals(other: FloatArray): Boolean
actual infix fun FloatArray?.contentEquals(other: FloatArray?): Boolean

Returns true if the two specified arrays are structurally equal to one another, i.e. contain the same number of the same elements in the same order.

contentHashCode
Link copied to clipboard
@DeprecatedSinceKotlin(hiddenSince = "1.4")
expect fun FloatArray.contentHashCode(): Int
expect fun FloatArray?.contentHashCode(): Int

Returns a hash code based on the contents of this array as if it is List.

@DeprecatedSinceKotlin(hiddenSince = "1.4")
actual inline fun FloatArray.contentHashCode(): Int
@JvmName(name = "contentHashCodeNullable")
actual inline fun FloatArray?.contentHashCode(): Int

Returns a hash code based on the contents of this array as if it is List.

@DeprecatedSinceKotlin(hiddenSince = "1.4")
actual fun FloatArray.contentHashCode(): Int
actual fun FloatArray?.contentHashCode(): Int

Returns a hash code based on the contents of this array as if it is List.

@DeprecatedSinceKotlin(hiddenSince = "1.4")
actual fun FloatArray.contentHashCode(): Int
actual fun FloatArray?.contentHashCode(): Int

Returns a hash code based on the contents of this array as if it is List.

contentToString
Link copied to clipboard
@DeprecatedSinceKotlin(hiddenSince = "1.4")
expect fun FloatArray.contentToString(): String
expect fun FloatArray?.contentToString(): String

Returns a string representation of the contents of the specified array as if it is List.

@DeprecatedSinceKotlin(hiddenSince = "1.4")
actual inline fun FloatArray.contentToString(): String
@JvmName(name = "contentToStringNullable")
actual inline fun FloatArray?.contentToString(): String

Returns a string representation of the contents of the specified array as if it is List.

@DeprecatedSinceKotlin(hiddenSince = "1.4")
actual fun FloatArray.contentToString(): String
actual fun FloatArray?.contentToString(): String

Returns a string representation of the contents of the specified array as if it is List.

@DeprecatedSinceKotlin(hiddenSince = "1.4")
actual fun FloatArray.contentToString(): String
actual fun FloatArray?.contentToString(): String

Returns a string representation of the contents of the specified array as if it is List.

copyInto
Link copied to clipboard
expect fun FloatArray.copyInto(destination: FloatArray, destinationOffset: Int, startIndex: Int, endIndex: Int): FloatArray

Copies this array or its subrange into the destination array and returns that array.

actual fun FloatArray.copyInto(destination: FloatArray, destinationOffset: Int, startIndex: Int, endIndex: Int): FloatArray

Copies this array or its subrange into the destination array and returns that array.

actual inline fun FloatArray.copyInto(destination: FloatArray, destinationOffset: Int, startIndex: Int, endIndex: Int): FloatArray

Copies this array or its subrange into the destination array and returns that array.

actual fun FloatArray.copyInto(destination: FloatArray, destinationOffset: Int, startIndex: Int, endIndex: Int): FloatArray

Copies this array or its subrange into the destination array and returns that array.

copyOf
Link copied to clipboard
expect fun FloatArray.copyOf(): FloatArray

Returns new array which is a copy of the original array.

expect fun FloatArray.copyOf(newSize: Int): FloatArray

Returns new array which is a copy of the original array, resized to the given newSize. The copy is either truncated or padded at the end with zero values if necessary.

actual inline fun FloatArray.copyOf(): FloatArray

Returns new array which is a copy of the original array.

actual inline fun FloatArray.copyOf(newSize: Int): FloatArray

Returns new array which is a copy of the original array, resized to the given newSize. The copy is either truncated or padded at the end with zero values if necessary.

actual inline fun FloatArray.copyOf(): FloatArray

Returns new array which is a copy of the original array.

actual fun FloatArray.copyOf(newSize: Int): FloatArray

Returns new array which is a copy of the original array, resized to the given newSize. The copy is either truncated or padded at the end with zero values if necessary.

actual fun FloatArray.copyOf(): FloatArray

Returns new array which is a copy of the original array.

actual fun FloatArray.copyOf(newSize: Int): FloatArray

Returns new array which is a copy of the original array, resized to the given newSize. The copy is either truncated or padded at the end with zero values if necessary.

copyOfRange
Link copied to clipboard
expect fun FloatArray.copyOfRange(fromIndex: Int, toIndex: Int): FloatArray

Returns a new array which is a copy of the specified range of the original array.

@JvmName(name = "copyOfRangeInline")
actual inline fun FloatArray.copyOfRange(fromIndex: Int, toIndex: Int): FloatArray

Returns a new array which is a copy of the specified range of the original array.

actual fun FloatArray.copyOfRange(fromIndex: Int, toIndex: Int): FloatArray

Returns a new array which is a copy of the specified range of the original array.

actual fun FloatArray.copyOfRange(fromIndex: Int, toIndex: Int): FloatArray

Returns a new array which is a copy of the specified range of the original array.

count
Link copied to clipboard
inline fun FloatArray.count(): Int

Returns the number of elements in this array.

inline fun FloatArray.count(predicate: (Float) -> Boolean): Int

Returns the number of elements matching the given predicate.

distinct
Link copied to clipboard
fun FloatArray.distinct(): List<Float>

Returns a list containing only distinct elements from the given array.

distinctBy
Link copied to clipboard
inline fun <K> FloatArray.distinctBy(selector: (Float) -> K): List<Float>

Returns a list containing only elements from the given array having distinct keys returned by the given selector function.

drop
Link copied to clipboard
fun FloatArray.drop(n: Int): List<Float>

Returns a list containing all elements except first n elements.

dropLast
Link copied to clipboard
fun FloatArray.dropLast(n: Int): List<Float>

Returns a list containing all elements except last n elements.

dropLastWhile
Link copied to clipboard
inline fun FloatArray.dropLastWhile(predicate: (Float) -> Boolean): List<Float>

Returns a list containing all elements except last elements that satisfy the given predicate.

dropWhile
Link copied to clipboard
inline fun FloatArray.dropWhile(predicate: (Float) -> Boolean): List<Float>

Returns a list containing all elements except first elements that satisfy the given predicate.

elementAt
Link copied to clipboard
expect fun FloatArray.elementAt(index: Int): Float

Returns an element at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this array.

actual inline fun FloatArray.elementAt(index: Int): Float

Returns an element at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this array.

actual fun FloatArray.elementAt(index: Int): Float

Returns an element at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this array.

actual inline fun FloatArray.elementAt(index: Int): Float

Returns an element at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this array.

elementAtOrElse
Link copied to clipboard
inline fun FloatArray.elementAtOrElse(index: Int, defaultValue: (Int) -> Float): Float

Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this array.

elementAtOrNull
Link copied to clipboard
inline fun FloatArray.elementAtOrNull(index: Int): Float?

Returns an element at the given index or null if the index is out of bounds of this array.

fill
Link copied to clipboard
expect fun FloatArray.fill(element: Float, fromIndex: Int, toIndex: Int)

Fills this array or its subrange with the specified element value.

actual fun FloatArray.fill(element: Float, fromIndex: Int, toIndex: Int)

Fills this array or its subrange with the specified element value.

actual fun FloatArray.fill(element: Float, fromIndex: Int, toIndex: Int)

Fills this array or its subrange with the specified element value.

actual fun FloatArray.fill(element: Float, fromIndex: Int, toIndex: Int)

Fills this array or its subrange with the specified element value.

filter
Link copied to clipboard
inline fun FloatArray.filter(predicate: (Float) -> Boolean): List<Float>

Returns a list containing only elements matching the given predicate.

filterIndexed
Link copied to clipboard
inline fun FloatArray.filterIndexed(predicate: (index: Int, Float) -> Boolean): List<Float>

Returns a list containing only elements matching the given predicate.

filterIndexedTo
Link copied to clipboard
inline fun <C : MutableCollection<in Float>> FloatArray.filterIndexedTo(destination: C, predicate: (index: Int, Float) -> Boolean): C

Appends all elements matching the given predicate to the given destination.

filterNot
Link copied to clipboard
inline fun FloatArray.filterNot(predicate: (Float) -> Boolean): List<Float>

Returns a list containing all elements not matching the given predicate.

filterNotTo
Link copied to clipboard
inline fun <C : MutableCollection<in Float>> FloatArray.filterNotTo(destination: C, predicate: (Float) -> Boolean): C

Appends all elements not matching the given predicate to the given destination.

filterTo
Link copied to clipboard
inline fun <C : MutableCollection<in Float>> FloatArray.filterTo(destination: C, predicate: (Float) -> Boolean): C

Appends all elements matching the given predicate to the given destination.

find
Link copied to clipboard
inline fun FloatArray.find(predicate: (Float) -> Boolean): Float?

Returns the first element matching the given predicate, or null if no such element was found.

findLast
Link copied to clipboard
inline fun FloatArray.findLast(predicate: (Float) -> Boolean): Float?

Returns the last element matching the given predicate, or null if no such element was found.

first
Link copied to clipboard
fun FloatArray.first(): Float

Returns first element.

inline fun FloatArray.first(predicate: (Float) -> Boolean): Float

Returns the first element matching the given predicate.

firstOrNull
Link copied to clipboard
fun FloatArray.firstOrNull(): Float?

Returns the first element, or null if the array is empty.

inline fun FloatArray.firstOrNull(predicate: (Float) -> Boolean): Float?

Returns the first element matching the given predicate, or null if element was not found.

flatMap
Link copied to clipboard
inline fun <R> FloatArray.flatMap(transform: (Float) -> Iterable<R>): List<R>

Returns a single list of all elements yielded from results of transform function being invoked on each element of original array.

flatMapIndexed
Link copied to clipboard
@JvmName(name = "flatMapIndexedIterable")
inline fun <R> FloatArray.flatMapIndexed(transform: (index: Int, Float) -> Iterable<R>): List<R>

Returns a single list of all elements yielded from results of transform function being invoked on each element and its index in the original array.

flatMapIndexedTo
Link copied to clipboard
@JvmName(name = "flatMapIndexedIterableTo")
inline fun <R, C : MutableCollection<in R>> FloatArray.flatMapIndexedTo(destination: C, transform: (index: Int, Float) -> Iterable<R>): C

Appends all elements yielded from results of transform function being invoked on each element and its index in the original array, to the given destination.

flatMapTo
Link copied to clipboard
inline fun <R, C : MutableCollection<in R>> FloatArray.flatMapTo(destination: C, transform: (Float) -> Iterable<R>): C

Appends all elements yielded from results of transform function being invoked on each element of original array, to the given destination.

fold
Link copied to clipboard
inline fun <R> FloatArray.fold(initial: R, operation: (R, Float) -> R): R

Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element.

foldIndexed
Link copied to clipboard
inline fun <R> FloatArray.foldIndexed(initial: R, operation: (index: Int, R, Float) -> R): R

Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element with its index in the original array.

foldRight
Link copied to clipboard
inline fun <R> FloatArray.foldRight(initial: R, operation: (Float, R) -> R): R

Accumulates value starting with initial value and applying operation from right to left to each element and current accumulator value.

foldRightIndexed
Link copied to clipboard
inline fun <R> FloatArray.foldRightIndexed(initial: R, operation: (index: Int, Float, R) -> R): R

Accumulates value starting with initial value and applying operation from right to left to each element with its index in the original array and current accumulator value.

forEach
Link copied to clipboard
inline fun FloatArray.forEach(action: (Float) -> Unit)

Performs the given action on each element.

forEachIndexed
Link copied to clipboard
inline fun FloatArray.forEachIndexed(action: (index: Int, Float) -> Unit)

Performs the given action on each element, providing sequential index with the element.

getOrElse
Link copied to clipboard
inline fun FloatArray.getOrElse(index: Int, defaultValue: (Int) -> Float): Float

Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this array.

getOrNull
Link copied to clipboard
fun FloatArray.getOrNull(index: Int): Float?

Returns an element at the given index or null if the index is out of bounds of this array.

groupBy
Link copied to clipboard
inline fun <K> FloatArray.groupBy(keySelector: (Float) -> K): Map<K, List<Float>>

Groups elements of the original array by the key returned by the given keySelector function applied to each element and returns a map where each group key is associated with a list of corresponding elements.

inline fun <K, V> FloatArray.groupBy(keySelector: (Float) -> K, valueTransform: (Float) -> V): Map<K, List<V>>

Groups values returned by the valueTransform function applied to each element of the original array by the key returned by the given keySelector function applied to the element and returns a map where each group key is associated with a list of corresponding values.

groupByTo
Link copied to clipboard
inline fun <K, M : MutableMap<in K, MutableList<Float>>> FloatArray.groupByTo(destination: M, keySelector: (Float) -> K): M

Groups elements of the original array by the key returned by the given keySelector function applied to each element and puts to the destination map each group key associated with a list of corresponding elements.

inline fun <K, V, M : MutableMap<in K, MutableList<V>>> FloatArray.groupByTo(destination: M, keySelector: (Float) -> K, valueTransform: (Float) -> V): M

Groups values returned by the valueTransform function applied to each element of the original array by the key returned by the given keySelector function applied to the element and puts to the destination map each group key associated with a list of corresponding values.

indexOf
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.4")
fun FloatArray.indexOf(element: Float): Int

Returns first index of element, or -1 if the array does not contain element.

indexOfFirst
Link copied to clipboard
inline fun FloatArray.indexOfFirst(predicate: (Float) -> Boolean): Int

Returns index of the first element matching the given predicate, or -1 if the array does not contain such element.

indexOfLast
Link copied to clipboard
inline fun FloatArray.indexOfLast(predicate: (Float) -> Boolean): Int

Returns index of the last element matching the given predicate, or -1 if the array does not contain such element.

indices
Link copied to clipboard
val FloatArray.indices: IntRange

Returns the range of valid indices for the array.

intersect
Link copied to clipboard
infix fun FloatArray.intersect(other: Iterable<Float>): Set<Float>

Returns a set containing all elements that are contained by both this array and the specified collection.

isEmpty
Link copied to clipboard
inline fun FloatArray.isEmpty(): Boolean

Returns true if the array is empty.

isNotEmpty
Link copied to clipboard
inline fun FloatArray.isNotEmpty(): Boolean

Returns true if the array is not empty.

joinTo
Link copied to clipboard
fun <A : Appendable> FloatArray.joinTo(buffer: A, separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (Float) -> CharSequence? = null): A

Appends the string from all the elements separated using separator and using the given prefix and postfix if supplied.

joinToString
Link copied to clipboard
fun FloatArray.joinToString(separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (Float) -> CharSequence? = null): String

Creates a string from all the elements separated using separator and using the given prefix and postfix if supplied.

last
Link copied to clipboard
fun FloatArray.last(): Float

Returns the last element.

inline fun FloatArray.last(predicate: (Float) -> Boolean): Float

Returns the last element matching the given predicate.

lastIndex
Link copied to clipboard
val FloatArray.lastIndex: Int

Returns the last valid index for the array.

lastIndexOf
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.4")
fun FloatArray.lastIndexOf(element: Float): Int

Returns last index of element, or -1 if the array does not contain element.

lastOrNull
Link copied to clipboard
fun FloatArray.lastOrNull(): Float?

Returns the last element, or null if the array is empty.

inline fun FloatArray.lastOrNull(predicate: (Float) -> Boolean): Float?

Returns the last element matching the given predicate, or null if no such element was found.

map
Link copied to clipboard
inline fun <R> FloatArray.map(transform: (Float) -> R): List<R>

Returns a list containing the results of applying the given transform function to each element in the original array.

mapIndexed
Link copied to clipboard
inline fun <R> FloatArray.mapIndexed(transform: (index: Int, Float) -> R): List<R>

Returns a list containing the results of applying the given transform function to each element and its index in the original array.

mapIndexedTo
Link copied to clipboard
inline fun <R, C : MutableCollection<in R>> FloatArray.mapIndexedTo(destination: C, transform: (index: Int, Float) -> R): C

Applies the given transform function to each element and its index in the original array and appends the results to the given destination.

mapTo
Link copied to clipboard
inline fun <R, C : MutableCollection<in R>> FloatArray.mapTo(destination: C, transform: (Float) -> R): C

Applies the given transform function to each element of the original array and appends the results to the given destination.

max
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.4", errorSince = "1.5")
fun FloatArray.max(): Float?
maxBy
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.4", errorSince = "1.5")
inline fun <R : Comparable<R>> FloatArray.maxBy(selector: (Float) -> R): Float?
maxByOrNull
Link copied to clipboard
inline fun <R : Comparable<R>> FloatArray.maxByOrNull(selector: (Float) -> R): Float?

Returns the first element yielding the largest value of the given function or null if there are no elements.

maxOf
Link copied to clipboard
inline fun FloatArray.maxOf(selector: (Float) -> Double): Double
inline fun FloatArray.maxOf(selector: (Float) -> Float): Float
inline fun <R : Comparable<R>> FloatArray.maxOf(selector: (Float) -> R): R

Returns the largest value among all values produced by selector function applied to each element in the array.

maxOfOrNull
Link copied to clipboard
inline fun FloatArray.maxOfOrNull(selector: (Float) -> Double): Double?
inline fun FloatArray.maxOfOrNull(selector: (Float) -> Float): Float?
inline fun <R : Comparable<R>> FloatArray.maxOfOrNull(selector: (Float) -> R): R?

Returns the largest value among all values produced by selector function applied to each element in the array or null if there are no elements.

maxOfWith
Link copied to clipboard
inline fun <R> FloatArray.maxOfWith(comparator: Comparator<in R>, selector: (Float) -> R): R

Returns the largest value according to the provided comparator among all values produced by selector function applied to each element in the array.

maxOfWithOrNull
Link copied to clipboard
inline fun <R> FloatArray.maxOfWithOrNull(comparator: Comparator<in R>, selector: (Float) -> R): R?

Returns the largest value according to the provided comparator among all values produced by selector function applied to each element in the array or null if there are no elements.

maxOrNull
Link copied to clipboard
fun FloatArray.maxOrNull(): Float?

Returns the largest element or null if there are no elements.

maxWith
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.4", errorSince = "1.5")
fun FloatArray.maxWith(comparator: Comparator<in Float>): Float?
maxWithOrNull
Link copied to clipboard
fun FloatArray.maxWithOrNull(comparator: Comparator<in Float>): Float?

Returns the first element having the largest value according to the provided comparator or null if there are no elements.

min
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.4", errorSince = "1.5")
fun FloatArray.min(): Float?
minBy
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.4", errorSince = "1.5")
inline fun <R : Comparable<R>> FloatArray.minBy(selector: (Float) -> R): Float?
minByOrNull
Link copied to clipboard
inline fun <R : Comparable<R>> FloatArray.minByOrNull(selector: (Float) -> R): Float?

Returns the first element yielding the smallest value of the given function or null if there are no elements.

minOf
Link copied to clipboard
inline fun FloatArray.minOf(selector: (Float) -> Double): Double
inline fun FloatArray.minOf(selector: (Float) -> Float): Float
inline fun <R : Comparable<R>> FloatArray.minOf(selector: (Float) -> R): R

Returns the smallest value among all values produced by selector function applied to each element in the array.

minOfOrNull
Link copied to clipboard
inline fun FloatArray.minOfOrNull(selector: (Float) -> Double): Double?
inline fun FloatArray.minOfOrNull(selector: (Float) -> Float): Float?
inline fun <R : Comparable<R>> FloatArray.minOfOrNull(selector: (Float) -> R): R?

Returns the smallest value among all values produced by selector function applied to each element in the array or null if there are no elements.

minOfWith
Link copied to clipboard
inline fun <R> FloatArray.minOfWith(comparator: Comparator<in R>, selector: (Float) -> R): R

Returns the smallest value according to the provided comparator among all values produced by selector function applied to each element in the array.

minOfWithOrNull
Link copied to clipboard
inline fun <R> FloatArray.minOfWithOrNull(comparator: Comparator<in R>, selector: (Float) -> R): R?

Returns the smallest value according to the provided comparator among all values produced by selector function applied to each element in the array or null if there are no elements.

minOrNull
Link copied to clipboard
fun FloatArray.minOrNull(): Float?

Returns the smallest element or null if there are no elements.

minWith
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.4", errorSince = "1.5")
fun FloatArray.minWith(comparator: Comparator<in Float>): Float?
minWithOrNull
Link copied to clipboard
fun FloatArray.minWithOrNull(comparator: Comparator<in Float>): Float?

Returns the first element having the smallest value according to the provided comparator or null if there are no elements.

none
Link copied to clipboard
fun FloatArray.none(): Boolean

Returns true if the array has no elements.

inline fun FloatArray.none(predicate: (Float) -> Boolean): Boolean

Returns true if no elements match the given predicate.

onEach
Link copied to clipboard
inline fun FloatArray.onEach(action: (Float) -> Unit): FloatArray

Performs the given action on each element and returns the array itself afterwards.

onEachIndexed
Link copied to clipboard
inline fun FloatArray.onEachIndexed(action: (index: Int, Float) -> Unit): FloatArray

Performs the given action on each element, providing sequential index with the element, and returns the array itself afterwards.

partition
Link copied to clipboard
inline fun FloatArray.partition(predicate: (Float) -> Boolean): Pair<List<Float>, List<Float>>

Splits the original array into pair of lists, where first list contains elements for which predicate yielded true, while second list contains elements for which predicate yielded false.

plus
Link copied to clipboard
expect operator fun FloatArray.plus(element: Float): FloatArray

Returns an array containing all elements of the original array and then the given element.

expect operator fun FloatArray.plus(elements: Collection<Float>): FloatArray

Returns an array containing all elements of the original array and then all elements of the given elements collection.

expect operator fun FloatArray.plus(elements: FloatArray): FloatArray

Returns an array containing all elements of the original array and then all elements of the given elements array.

actual operator fun FloatArray.plus(element: Float): FloatArray

Returns an array containing all elements of the original array and then the given element.

actual operator fun FloatArray.plus(elements: Collection<Float>): FloatArray

Returns an array containing all elements of the original array and then all elements of the given elements collection.

actual operator fun FloatArray.plus(elements: FloatArray): FloatArray

Returns an array containing all elements of the original array and then all elements of the given elements array.

actual inline operator fun FloatArray.plus(element: Float): FloatArray

Returns an array containing all elements of the original array and then the given element.

actual operator fun FloatArray.plus(elements: Collection<Float>): FloatArray

Returns an array containing all elements of the original array and then all elements of the given elements collection.

actual inline operator fun FloatArray.plus(elements: FloatArray): FloatArray

Returns an array containing all elements of the original array and then all elements of the given elements array.

actual operator fun FloatArray.plus(element: Float): FloatArray

Returns an array containing all elements of the original array and then the given element.

actual operator fun FloatArray.plus(elements: Collection<Float>): FloatArray

Returns an array containing all elements of the original array and then all elements of the given elements collection.

actual operator fun FloatArray.plus(elements: FloatArray): FloatArray

Returns an array containing all elements of the original array and then all elements of the given elements array.

random
Link copied to clipboard
inline fun FloatArray.random(): Float

Returns a random element from this array.

fun FloatArray.random(random: Random): Float

Returns a random element from this array using the specified source of randomness.

randomOrNull
Link copied to clipboard
inline fun FloatArray.randomOrNull(): Float?

Returns a random element from this array, or null if this array is empty.

fun FloatArray.randomOrNull(random: Random): Float?

Returns a random element from this array using the specified source of randomness, or null if this array is empty.

reduce
Link copied to clipboard
inline fun FloatArray.reduce(operation: (acc: Float, Float) -> Float): Float

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element.

reduceIndexed
Link copied to clipboard
inline fun FloatArray.reduceIndexed(operation: (index: Int, acc: Float, Float) -> Float): Float

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element with its index in the original array.

reduceIndexedOrNull
Link copied to clipboard
inline fun FloatArray.reduceIndexedOrNull(operation: (index: Int, acc: Float, Float) -> Float): Float?

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element with its index in the original array.

reduceOrNull
Link copied to clipboard
inline fun FloatArray.reduceOrNull(operation: (acc: Float, Float) -> Float): Float?

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element.

reduceRight
Link copied to clipboard
inline fun FloatArray.reduceRight(operation: (Float, acc: Float) -> Float): Float

Accumulates value starting with the last element and applying operation from right to left to each element and current accumulator value.

reduceRightIndexed
Link copied to clipboard
inline fun FloatArray.reduceRightIndexed(operation: (index: Int, Float, acc: Float) -> Float): Float

Accumulates value starting with the last element and applying operation from right to left to each element with its index in the original array and current accumulator value.

reduceRightIndexedOrNull
Link copied to clipboard
inline fun FloatArray.reduceRightIndexedOrNull(operation: (index: Int, Float, acc: Float) -> Float): Float?

Accumulates value starting with the last element and applying operation from right to left to each element with its index in the original array and current accumulator value.

reduceRightOrNull
Link copied to clipboard
inline fun FloatArray.reduceRightOrNull(operation: (Float, acc: Float) -> Float): Float?

Accumulates value starting with the last element and applying operation from right to left to each element and current accumulator value.

refTo
Link copied to clipboard
fun FloatArray.refTo(index: Int): CValuesRef<FloatVar>
reverse
Link copied to clipboard
fun FloatArray.reverse()

Reverses elements in the array in-place.

fun FloatArray.reverse(fromIndex: Int, toIndex: Int)

Reverses elements of the array in the specified range in-place.

reversed
Link copied to clipboard
fun FloatArray.reversed(): List<Float>

Returns a list with elements in reversed order.

reversedArray
Link copied to clipboard
fun FloatArray.reversedArray(): FloatArray

Returns an array with elements of this array in reversed order.

runningFold
Link copied to clipboard
inline fun <R> FloatArray.runningFold(initial: R, operation: (R, Float) -> R): List<R>

Returns a list containing successive accumulation values generated by applying operation from left to right to each element and current accumulator value that starts with initial value.

runningFoldIndexed
Link copied to clipboard
inline fun <R> FloatArray.runningFoldIndexed(initial: R, operation: (index: Int, R, Float) -> R): List<R>

Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original array and current accumulator value that starts with initial value.

runningReduce
Link copied to clipboard
inline fun FloatArray.runningReduce(operation: (acc: Float, Float) -> Float): List<Float>

Returns a list containing successive accumulation values generated by applying operation from left to right to each element and current accumulator value that starts with the first element of this array.

runningReduceIndexed
Link copied to clipboard
inline fun FloatArray.runningReduceIndexed(operation: (index: Int, acc: Float, Float) -> Float): List<Float>

Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original array and current accumulator value that starts with the first element of this array.

scan
Link copied to clipboard
inline fun <R> FloatArray.scan(initial: R, operation: (R, Float) -> R): List<R>

Returns a list containing successive accumulation values generated by applying operation from left to right to each element and current accumulator value that starts with initial value.

scanIndexed
Link copied to clipboard
inline fun <R> FloatArray.scanIndexed(initial: R, operation: (index: Int, R, Float) -> R): List<R>

Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original array and current accumulator value that starts with initial value.

shuffle
Link copied to clipboard
fun FloatArray.shuffle()

Randomly shuffles elements in this array in-place.

fun FloatArray.shuffle(random: Random)

Randomly shuffles elements in this array in-place using the specified random instance as the source of randomness.

single
Link copied to clipboard
fun FloatArray.single(): Float

Returns the single element, or throws an exception if the array is empty or has more than one element.

inline fun FloatArray.single(predicate: (Float) -> Boolean): Float

Returns the single element matching the given predicate, or throws exception if there is no or more than one matching element.

singleOrNull
Link copied to clipboard
fun FloatArray.singleOrNull(): Float?

Returns single element, or null if the array is empty or has more than one element.

inline fun FloatArray.singleOrNull(predicate: (Float) -> Boolean): Float?

Returns the single element matching the given predicate, or null if element was not found or more than one element was found.

slice
Link copied to clipboard
fun FloatArray.slice(indices: IntRange): List<Float>

Returns a list containing elements at indices in the specified indices range.

fun FloatArray.slice(indices: Iterable<Int>): List<Float>

Returns a list containing elements at specified indices.

sliceArray
Link copied to clipboard
fun FloatArray.sliceArray(indices: Collection<Int>): FloatArray

Returns an array containing elements of this array at specified indices.

fun FloatArray.sliceArray(indices: IntRange): FloatArray

Returns an array containing elements at indices in the specified indices range.

sort
Link copied to clipboard
expect fun FloatArray.sort()

Sorts the array in-place.

expect fun FloatArray.sort(fromIndex: Int, toIndex: Int)

Sorts a range in the array in-place.

actual fun FloatArray.sort()

Sorts the array in-place.

actual fun FloatArray.sort(fromIndex: Int, toIndex: Int)

Sorts a range in the array in-place.

inline fun FloatArray.sort(noinline comparison: (a: Float, b: Float) -> Int)

Sorts the array in-place according to the order specified by the given comparison function.

actual fun FloatArray.sort()

Sorts the array in-place.

actual fun FloatArray.sort(fromIndex: Int, toIndex: Int)

Sorts a range in the array in-place.

actual fun FloatArray.sort()

Sorts the array in-place.

actual fun FloatArray.sort(fromIndex: Int, toIndex: Int)

Sorts a range in the array in-place.

sortDescending
Link copied to clipboard
fun FloatArray.sortDescending()

Sorts elements in the array in-place descending according to their natural sort order.

fun FloatArray.sortDescending(fromIndex: Int, toIndex: Int)

Sorts elements of the array in the specified range in-place. The elements are sorted descending according to their natural sort order.

sorted
Link copied to clipboard
fun FloatArray.sorted(): List<Float>

Returns a list of all elements sorted according to their natural sort order.

sortedArray
Link copied to clipboard
fun FloatArray.sortedArray(): FloatArray

Returns an array with all elements of this array sorted according to their natural sort order.

sortedArrayDescending
Link copied to clipboard
fun FloatArray.sortedArrayDescending(): FloatArray

Returns an array with all elements of this array sorted descending according to their natural sort order.

sortedBy
Link copied to clipboard
inline fun <R : Comparable<R>> FloatArray.sortedBy(crossinline selector: (Float) -> R?): List<Float>

Returns a list of all elements sorted according to natural sort order of the value returned by specified selector function.

sortedByDescending
Link copied to clipboard
inline fun <R : Comparable<R>> FloatArray.sortedByDescending(crossinline selector: (Float) -> R?): List<Float>

Returns a list of all elements sorted descending according to natural sort order of the value returned by specified selector function.

sortedDescending
Link copied to clipboard
fun FloatArray.sortedDescending(): List<Float>

Returns a list of all elements sorted descending according to their natural sort order.

sortedWith
Link copied to clipboard
fun FloatArray.sortedWith(comparator: Comparator<in Float>): List<Float>

Returns a list of all elements sorted according to the specified comparator.

subtract
Link copied to clipboard
infix fun FloatArray.subtract(other: Iterable<Float>): Set<Float>

Returns a set containing all elements that are contained by this array and not contained by the specified collection.

sum
Link copied to clipboard
fun FloatArray.sum(): Float

Returns the sum of all elements in the array.

sumBy
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.5")
inline fun FloatArray.sumBy(selector: (Float) -> Int): Int

Returns the sum of all values produced by selector function applied to each element in the array.

sumByDouble
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.5")
inline fun FloatArray.sumByDouble(selector: (Float) -> Double): Double

Returns the sum of all values produced by selector function applied to each element in the array.

sumOf
Link copied to clipboard
@JvmName(name = "sumOfDouble")
inline fun FloatArray.sumOf(selector: (Float) -> Double): Double
@JvmName(name = "sumOfInt")
inline fun FloatArray.sumOf(selector: (Float) -> Int): Int
@JvmName(name = "sumOfLong")
inline fun FloatArray.sumOf(selector: (Float) -> Long): Long
@JvmName(name = "sumOfUInt")
inline fun FloatArray.sumOf(selector: (Float) -> UInt): UInt
@JvmName(name = "sumOfULong")
inline fun FloatArray.sumOf(selector: (Float) -> ULong): ULong

Returns the sum of all values produced by selector function applied to each element in the array.

@JvmName(name = "sumOfBigDecimal")
inline fun FloatArray.sumOf(selector: (Float) -> BigDecimal): BigDecimal
@JvmName(name = "sumOfBigInteger")
inline fun FloatArray.sumOf(selector: (Float) -> BigInteger): BigInteger

Returns the sum of all values produced by selector function applied to each element in the array.

take
Link copied to clipboard
fun FloatArray.take(n: Int): List<Float>

Returns a list containing first n elements.

takeLast
Link copied to clipboard
fun FloatArray.takeLast(n: Int): List<Float>

Returns a list containing last n elements.

takeLastWhile
Link copied to clipboard
inline fun FloatArray.takeLastWhile(predicate: (Float) -> Boolean): List<Float>

Returns a list containing last elements satisfying the given predicate.

takeWhile
Link copied to clipboard
inline fun FloatArray.takeWhile(predicate: (Float) -> Boolean): List<Float>

Returns a list containing first elements satisfying the given predicate.

toCollection
Link copied to clipboard
fun <C : MutableCollection<in Float>> FloatArray.toCollection(destination: C): C

Appends all elements to the given destination collection.

toCValues
Link copied to clipboard
fun FloatArray.toCValues(): CValues<FloatVar>
toHashSet
Link copied to clipboard
fun FloatArray.toHashSet(): HashSet<Float>

Returns a new HashSet of all elements.

toList
Link copied to clipboard
fun FloatArray.toList(): List<Float>

Returns a List containing all elements.

toMutableList
Link copied to clipboard
fun FloatArray.toMutableList(): MutableList<Float>

Returns a new MutableList filled with all elements of this array.

toMutableSet
Link copied to clipboard
fun FloatArray.toMutableSet(): MutableSet<Float>

Returns a new MutableSet containing all distinct elements from the given array.

toSet
Link copied to clipboard
fun FloatArray.toSet(): Set<Float>

Returns a Set of all elements.

toSortedSet
Link copied to clipboard
fun FloatArray.toSortedSet(): SortedSet<Float>

Returns a new SortedSet of all elements.

toTypedArray
Link copied to clipboard
expect fun FloatArray.toTypedArray(): Array<Float>

Returns a typed object array containing all of the elements of this primitive array.

actual fun FloatArray.toTypedArray(): Array<Float>

Returns a typed object array containing all of the elements of this primitive array.

actual fun FloatArray.toTypedArray(): Array<Float>

Returns a typed object array containing all of the elements of this primitive array.

actual fun FloatArray.toTypedArray(): Array<Float>

Returns a typed object array containing all of the elements of this primitive array.

union
Link copied to clipboard
infix fun FloatArray.union(other: Iterable<Float>): Set<Float>

Returns a set containing all distinct elements from both collections.

withIndex
Link copied to clipboard
fun FloatArray.withIndex(): Iterable<IndexedValue<Float>>

Returns a lazy Iterable that wraps each element of the original array into an IndexedValue containing the index of that element and the element itself.

zip
Link copied to clipboard
infix fun <R> FloatArray.zip(other: Array<out R>): List<Pair<Float, R>>
infix fun FloatArray.zip(other: FloatArray): List<Pair<Float, Float>>

Returns a list of pairs built from the elements of this array and the other array with the same index. The returned list has length of the shortest collection.

inline fun <R, V> FloatArray.zip(other: Array<out R>, transform: (a: Float, R) -> V): List<V>

Returns a list of values built from the elements of this array and the other array with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest collection.

infix fun <R> FloatArray.zip(other: Iterable<R>): List<Pair<Float, R>>

Returns a list of pairs built from the elements of this collection and other array with the same index. The returned list has length of the shortest collection.

inline fun <R, V> FloatArray.zip(other: Iterable<R>, transform: (a: Float, R) -> V): List<V>

Returns a list of values built from the elements of this array and the other collection with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest collection.

inline fun <V> FloatArray.zip(other: FloatArray, transform: (a: Float, b: Float) -> V): List<V>

Returns a list of values built from the elements of this array and the other array with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest array.